/**
 * Copyright (C) 2008 GeoScheduler Team, as stated on <http://www.geoscheduler.org/authors>.
 * 
 * This file is part of GeoScheduler.
 * 
 * GeoScheduler is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * GeoScheduler is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with GeoScheduler. If not, see <http://www.gnu.org/licenses/>.
 */

package org.geoscheduler.commons.marshaller;

import org.json.JSONException;
import org.json.JSONObject;

/**
 * 
 * <h2>JSONFieldDecl</h2>
 * <p>
 * Builder contract for marshaller/unmarshaller of JSON field. Builder is
 * controlled by {@link JSONMarshaller} implementation.
 * </p>
 * 
 * @see JSONMarshaller
 * @author LKo (Lukas.Kolisko@Geoscheduler.Org)
 */
public interface JSONFieldDecl<T> {

	/** @return JavaBean property name */
	String getName();

	/** @return name used in JSON representation */
	String getJSONName();

	/** @return property value type */
	Class<T> getType();

	/** @return default value set in annotation */
	T getDefaultValue();

	/**
	 * Unmrashall data from {@param instance} to JS
	 * 
	 * @param marshaller
	 *            marshalling controller
	 * @param instance
	 *            target instance
	 * @param obj
	 *            JSON object holding data for unmarshalling
	 * @return instance with unmarshalled values
	 * @throws JSONException
	 */
	Object unmarshall(JSONMarshaller marshaller, Object instance, JSONObject obj) throws JSONException;

	/**
	 * Marshall {@param instance} to {@param obj} JSON object.
	 * 
	 * @param marshaller
	 *            marshaling controller object
	 * @param instance
	 *            instance to be marshalled
	 * @param obj
	 *            JSON Object source
	 * @return obj instance with marshalled values
	 * @throws JSONException
	 */
	JSONObject marshall(JSONMarshaller marshaller, Object instance, JSONObject obj) throws JSONException;

}
